home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / u_man / cat1 / pmdaespping.z / pmdaespping
Encoding:
Text File  |  2001-04-17  |  10.4 KB  |  199 lines
  1.  
  2.  
  3.  
  4. PPPPMMMMDDDDAAAAEEEESSSSPPPPPPPPIIIINNNNGGGG((((1111))))                                                  PPPPMMMMDDDDAAAAEEEESSSSPPPPPPPPIIIINNNNGGGG((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg - generic probe performance metrics domain agent
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ////vvvvaaaarrrr////ppppccccpppp////ppppmmmmddddaaaassss////eeeessssppppppppiiiinnnngggg////ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg [----CCCC] [----dddd _d_o_m_a_i_n] [----llll _l_o_g_f_i_l_e] [----IIII
  13.      _i_n_t_e_r_v_a_l] [----tttt _t_i_m_e_o_u_t] _c_o_n_f_i_g_f_i_l_e
  14.  
  15. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.      ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg is a Performance Metrics Domain Agent (PMDA) which exports
  17.      quality of service and response time measurements for arbitrary commands
  18.      as might be run from a shell such as sssshhhh(1).
  19.  
  20.      These measurements are intended to be used to quantify service quality
  21.      and service availability for those services that are either mission
  22.      critical or act as early indicators of adverse system performance.  For
  23.      these reasons, ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg is used to provide service probe capabilities
  24.      for the System Group Management (SGM) component of the Embedded Support
  25.      Partner (ESP) tools.
  26.  
  27.      The sample configuration can be used to monitor various services, both
  28.      locally and remotely, such as ICMP response (using ppppiiiinnnngggg(1)), DNS lookup
  29.      via nnnnssssllllooooooookkkkuuuupppp(1), bind/portmapper service using rrrrppppccccbbbbiiiinnnndddd(1), SMTP by
  30.      connecting to telnet port 25 and sending an ``expn root'' request, NNTP
  31.      by connecting to telnet port 119 and running a ``listgroup'' command, and
  32.      numerous others.
  33.  
  34.      It is expected that other commands would follow the examples in the
  35.      sample configuration files (see the ``FILES'' section below).
  36.  
  37.      A brief description of the ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg command line options follows:
  38.  
  39.      ----CCCC   Parse _c_o_n_f_i_g_f_i_l_e, reporting any errors and exiting with non-zero
  40.           status if the file contains syntactical errors.
  41.  
  42.      ----dddd   It is absolutely crucial that the performance metrics _d_o_m_a_i_n number
  43.           specified here is unique and consistent.  That is, _d_o_m_a_i_n should be
  44.           different for every PMDA on the one host, and the same _d_o_m_a_i_n number
  45.           should be used for the same PMDA on all hosts.
  46.  
  47.      ----llll   By default a log file named _e_s_p_p_i_n_g._l_o_g is written in the directory
  48.           where ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg is started, i.e. since ppppmmmmccccdddd(1) makes
  49.           /_v_a_r/_a_d_m/_p_c_p_l_o_g (or $$$$PPPPCCCCPPPP____LLLLOOOOGGGGDDDDIIIIRRRR if set in the environment) its
  50.           current directory, the default logfile for ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg is
  51.           ${_P_C_P__L_O_G_D_I_R-/_v_a_r/_a_d_m/_p_c_p_l_o_g}/_e_s_p_p_i_n_g._l_o_g.  If the log file cannot
  52.           be created or is not writable, output is written to standard error
  53.           instead.
  54.  
  55.           The ----llll option specifies an alternative name for the log file.
  56.  
  57.      ----IIII   Amount of time (in seconds) between subsequent executions of the
  58.           list of commands provided via the configuration file _c_o_n_f_i_g_f_i_l_e.
  59.           The default is 2 minutes.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. PPPPMMMMDDDDAAAAEEEESSSSPPPPPPPPIIIINNNNGGGG((((1111))))                                                  PPPPMMMMDDDDAAAAEEEESSSSPPPPPPPPIIIINNNNGGGG((((1111))))
  71.  
  72.  
  73.  
  74.      ----tttt   Amount of time (in seconds) to wait before timing out awaiting a
  75.           response for a command from _c_o_n_f_i_g_f_i_l_e.  The default is 20 seconds.
  76.  
  77.      The required _c_o_n_f_i_g_f_i_l_e specifies ``tag'' and ``command'' pairs, each on
  78.      a separate line.  All of the commands are run one after another, with the
  79.      whole group rescheduled to be run once per _i_n_t_e_r_v_a_l.  For each command
  80.      that is run, ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg records information related to the success (or
  81.      timeout), exit status, elapsed time and CPU time (system and user), and
  82.      this information is exported by the PMDA.  The tags are used to identify
  83.      the individual commands amongst the values exported by the PMDA, and form
  84.      the external instance domain identifiers for the ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg metrics
  85.      which relate to each command.
  86.  
  87. IIIINNNNSSSSTTTTAAAALLLLLLLLAAAATTTTIIIIOOOONNNN
  88.      In order for a host to export the names, help text and values for the
  89.      espping performance metrics, do the following as root:
  90.  
  91.           # cd /var/pcp/pmdas/espping
  92.           # cp sample.map sgm.map
  93.           # vi sgm.map
  94.           # ./Configure
  95.  
  96.      The map file which is passed in to the Configure script associates host
  97.      names with services to be monitored on each hostname.  The list of
  98.      services is contained in the file /_v_a_r/_p_c_p/_p_m_d_a_s/_e_s_p_p_i_n_g/_t_e_m_p_l_a_t_e._c_o_n_f,
  99.      and this file can be extended with customized service probe mechanisms.
  100.  
  101.      The set of ``tag'' and ``command'' pairs may be generated via the
  102.      Configure script (as above), or specified from a default (sample)
  103.      configuration file, a customized file or entered interactively as part of
  104.      the Install script (use of the Install script is automated using
  105.      Configure).
  106.  
  107.      If you want to undo the installation, do the following as root:
  108.  
  109.           # cd /usr/pcp/pmdas/espping
  110.           # ./Remove
  111.  
  112.      ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg is launched by ppppmmmmccccdddd(1) and should never be executed directly.
  113.      The Install and Remove scripts notify ppppmmmmccccdddd(1) when the agent is installed
  114.      or removed.
  115.  
  116. FFFFIIIILLLLEEEESSSS
  117.      ////eeeettttcccc////ppppmmmmccccdddd....ccccoooonnnnffff
  118.                command line options used to launch ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg
  119.      ////vvvvaaaarrrr////ppppccccpppp////ppppmmmmddddaaaassss////eeeessssppppppppiiiinnnngggg////hhhheeeellllpppp
  120.                default help text file for the espping metrics
  121.      ////vvvvaaaarrrr////ppppccccpppp////ppppmmmmddddaaaassss////eeeessssppppppppiiiinnnngggg////tttteeeemmmmppppllllaaaatttteeee....ccccoooonnnnffff
  122.                template configuration file with a number of common service
  123.                probe mechanisms
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. PPPPMMMMDDDDAAAAEEEESSSSPPPPPPPPIIIINNNNGGGG((((1111))))                                                  PPPPMMMMDDDDAAAAEEEESSSSPPPPPPPPIIIINNNNGGGG((((1111))))
  137.  
  138.  
  139.  
  140.      ////vvvvaaaarrrr////ppppccccpppp////ppppmmmmddddaaaassss////eeeessssppppppppiiiinnnngggg////ssssaaaammmmpppplllleeee....mmmmaaaapppp
  141.                example mapping file for configuring which services to monitor,
  142.                and at which hosts
  143.      ////vvvvaaaarrrr////ppppccccpppp////ppppmmmmddddaaaassss////eeeessssppppppppiiiinnnngggg////ssssaaaammmmpppplllleeee....ccccoooonnnnffff
  144.                example configuration file with a number of common commands
  145.      ////vvvvaaaarrrr////ppppccccpppp////ppppmmmmddddaaaassss////eeeessssppppppppiiiinnnngggg////CCCCoooonnnnffffiiiigggguuuurrrreeee
  146.                installation script for ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg
  147.      ////vvvvaaaarrrr////ppppccccpppp////ppppmmmmddddaaaassss////eeeessssppppppppiiiinnnngggg////IIIInnnnssssttttaaaallllllll
  148.                direct installation script (bypass Configure) for ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg
  149.      ////uuuussssrrrr////ppppccccpppp////ppppmmmmddddaaaassss////eeeessssppppppppiiiinnnngggg////RRRReeeemmmmoooovvvveeee
  150.                undo installation script for ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg
  151.      $$$${{{{PPPPCCCCPPPP____LLLLOOOOGGGGDDDDIIIIRRRR----////vvvvaaaarrrr////aaaaddddmmmm////ppppccccpppplllloooogggg}}}}////eeeessssppppppppiiiinnnngggg....lllloooogggg
  152.                default log file for error messages and other information from
  153.                ppppmmmmddddaaaaeeeessssppppppppiiiinnnngggg
  154.  
  155. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  156.      ppppmmmmccccdddd(1)
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.